home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / language / osmall / typeinf / readme < prev   
Text File  |  1994-10-24  |  7KB  |  245 lines
  1.                   O'SMALL TYPE INFERENCER Version 0.24 March 1994
  2.  
  3.             Andreas V. Hense
  4.             Universitaet des Saarlandes
  5.             Fachbereich 14 - Informatik
  6.             Postfach 15 1150
  7.             D - 66041 Saarbruecken
  8.             e-mail:        hense@cs.uni-sb.de
  9.  
  10.  
  11.  
  12.  
  13.  
  14. O'small is an object-oriented programming language developed at the
  15. Universitaet des Saarlandes. The type inferencer is now available by
  16. anonymous ftp in addition to an interpreter and a compiler.
  17.  
  18. O'small is mainly suited for academic purposes. The language itself
  19. can be MODIFIED because the source code of the type inferencer and the
  20. specifications for the parser and scanner generators are available.
  21. Using these generators you can make experiments for your own research
  22. in statical analysis of object-oriented languages and questions related
  23. to language design.
  24.  
  25.  
  26.  
  27.  
  28.  
  29. ----------------------------------------------
  30.  
  31. O'SMALL TYPE INFERENCER COPYRIGHT NOTICE, LICENSE AND DISCLAIMER.
  32.  
  33. Copyright 1994 by Andreas V. Hense
  34.  
  35. Permission to use, copy, modify, and distribute this software and its
  36. documentation for any purpose and without fee is hereby granted,
  37. provided that the above copyright notice appear in all copies and that
  38. both the copyright notice and this permission notice and warranty
  39. disclaimer appear in supporting documentation.
  40.  
  41. The author disclaims all warranties with regard to this software, including
  42. all implied warranties of merchantability and fitness.  In no event
  43. shall the author be liable for any special, indirect or consequential
  44. damages or any damages whatsoever resulting from loss of use, data or
  45. profits, whether in an action of contract, negligence or other
  46. tortious action, arising out of or in connection with the use or
  47. performance of this software.
  48.  
  49. ----------------------------------------------
  50.  
  51.  
  52.  
  53.  
  54.  
  55. How to obtain the O'SMALL TYPE INFERENCER
  56. -----------------------------------------
  57.  
  58. Send comments and bug reports to:         hense@cs.uni-sb.de
  59.  
  60.  
  61. The means of distributing the type inferencer is anonymous internet
  62. ftp. The following table gives the ftp connection information.
  63.  
  64. Host:             Net Address:      Directory:
  65. -------------------------------------------------------------
  66. cs.uni-sb.de            134.96.7.254      /pub/osmall/typeInf
  67.  
  68. The directory /pub/osmall/typeInf contains this README file and the
  69. compressed tar file osmTI024.tar.Z.
  70.  
  71. ***************************************************************************
  72. NOTE: Ftp should be put into binary mode before transferring the compressed
  73. tar file.
  74. ***************************************************************************
  75.  
  76. Here is a sample dialog:
  77.  
  78.    ftp
  79.    ftp> open cs.uni-sb.de
  80.    Name: anonymous
  81.    Password: <your name>
  82.    ftp> binary
  83.    ftp> cd /pub/osmall/typeInf
  84.    ftp> get README
  85.    ftp> get osmTI024.tar.Z
  86.    ftp> close
  87.    ftp> quit
  88.  
  89. After the files are transferred they should be uncompressed 
  90. and then extracted using tar into a directory called (e.g.) typeInf.
  91. For example:
  92.  
  93.    mkdir typeInf
  94.    mv osmTI024.tar.Z typeInf
  95.    cd typeInf
  96.    uncompress -c osmTI024.tar.Z | tar xf -
  97.  
  98.  
  99.  
  100.  
  101.  
  102. Running under SUN OS 4.1.x
  103. --------------------------
  104.  
  105. The O'small Type Inferencer is invoked with 
  106.  
  107. > infer <filename>
  108.  
  109. If you omit the filename it will prompt you for one. The file should be an
  110. O'small program. O'small programs are kept in files with the extension
  111. .osm (e.g.: integer.osm). At the prompt
  112.  
  113. Please enter filename of O'small source
  114. > 
  115.  
  116. simply fill in the file name without the extension (e.g.: `integer').
  117.  
  118.  
  119.  
  120.  
  121. Running under other operating systems and recompilation
  122. -------------------------------------------------------
  123.  
  124. This software is written in Caml Light [LW93,WL93]. Caml Light is available
  125. by anonymous FTP:
  126.  
  127. Host:        ftp.inria.fr (Internet address 192.93.2.54)
  128. Login name:    anonymous
  129. Password:    your e-mail address
  130. Directory:    lang/caml-light
  131. Files:        depending on your hardware
  132.  
  133. The main advantage of Caml Light is its economical use of resources. It runs
  134. on all kind of hardware platforms: Unix, MacIntosh, PC, Atari. The hardware
  135. does not have to be very powerful. E.g., the O'small Type Inferencer has 
  136. been developed on a 386-SX with 16MHz and 2MB of main memory.
  137.  
  138. To compile and install the O'small Type Inferencer, be sure that you have 
  139. Caml Light properly installed on your machine. Then simply type 
  140.  
  141. > make
  142.  
  143. in the directory osmall. If make complains check the file `makefile'. Your
  144. version of make may be incompatible with ordinary UNIX make.
  145.  
  146. If you intend to play with the system or enhance it (e.g. make it more
  147. efficient), you will find the command 
  148.  
  149. > make sig
  150.  
  151. interesting. This command will result in a series of compilations creating
  152. a file `sig' that contains the complete interface information of the system.
  153. If for some module there exists an .mli file this file will not be 
  154. overwritten but will be appended to the file `sig'.
  155.  
  156. The lexer and parser are generated by camllex and camlyacc.
  157. The concrete syntax of O'small can be gathered from the O'small example
  158. programs in the directory osmProgs. Alternatively, you might like to read
  159. the files osmlex.mll and osmpar.mly for a complete specification. 
  160. O'small's syntax is now more flexible than described in [Hen91g].
  161.  
  162.  
  163.  
  164.  
  165. Running O'small Programs
  166. ------------------------
  167.  
  168. Although programs can be type checked without ever being run, here is the
  169. location of the O'small compiler for all those who are curious what their
  170. programs actually do:
  171.  
  172. Host:             Net Address:      Directory:
  173. -------------------------------------------------------------
  174. cs.uni-sb.de            134.96.7.254      /pub/osmall/machine
  175.  
  176. The directory /pub/osmall/machine contains this README file and the
  177. compressed tar file oma.1.00.tar.Z. The compiler is described in [BFHW94].
  178.  
  179.  
  180.  
  181.  
  182. O'small Example Programs
  183. ------------------------
  184.  
  185. Some of the example programs in this directory are refused by the type
  186. checker. These programs serve the purpose of demonstrating the limitations
  187. of the approach.
  188.  
  189. The type inference may take a LONG time. Therefore, at each series of
  190. resolution steps, a dot is printed on the screen. The types of variables
  191. are printed each time they are looked up in the directory. Before such
  192. a lookup the system of equations is brought into normal form. Thus, an
  193. eventual type clash can be localized to be after the last right-hand side
  194. occurrence of a let bound variable.
  195.  
  196.  
  197.  
  198.  
  199. Bugs
  200. ----
  201. The type checker is a one to one implementation of a declarative 
  202. algorithm described in [Hen94]. It has many inefficiencies that make
  203. it hard to run -- even on a fast machine. It should be run on small O'small
  204. programs only.
  205.  
  206.  
  207.  
  208. References
  209. ----------
  210.  
  211.  
  212. [BFHW94]    C. Boeschen, C. Fecht, A. V. Hense, R. Wilhelm
  213.         An Abstract Machine for an Object-Oriented Language with
  214.            Top-Level Classes,
  215.         Universitaet des Saarlandes, Fachbereich 14,
  216.         D-66123 Saarbruecken,
  217.         A 02/94, March 1994
  218.  
  219.  
  220. [Hen91g]    Andreas V. Hense
  221.         An O'small Interpreter Based on Denotational Semantics,
  222.         Universitaet des Saarlandes, Fachbereich 14,
  223.         D-66123 Saarbruecken,
  224.         A 07/91, November 1991
  225.  
  226.  
  227. [Hen94]        Andreas V. Hense
  228.         Polymorphic Type Inference for Object-Oriented Programming
  229.            Languages,
  230.         Universitaet des Saarlandes, Fachbereich 14,
  231.         D-66123 Saarbruecken,
  232.         1994, forthcoming
  233.  
  234.  
  235. [LW93]        X. Leroy, P. Weis
  236.         Manuel de reference du langage Caml,
  237.         InterEditions,
  238.         Paris 1993
  239.  
  240.  
  241. [WL93]        P. Weis, X. Leroy
  242.         Le langage Caml,
  243.         InterEditions,
  244.         Paris 1993
  245.